<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.telemetry.analyzer.function;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    /**<a name="line.3"></a>
<FONT color="green">004</FONT>     * Provides an abstract base class for telemetry functions. <a name="line.4"></a>
<FONT color="green">005</FONT>     * A telemetry function operates on an array of<a name="line.5"></a>
<FONT color="green">006</FONT>     * &lt;code&gt;Number&lt;/code&gt; and/or &lt;code&gt;TelemetryStreamCollection&lt;/code&gt; objects, and <a name="line.6"></a>
<FONT color="green">007</FONT>     * returns either a &lt;code&gt;Number&lt;/code&gt; or a &lt;code&gt;TelemetryStreamCollection&lt;/code&gt; object.<a name="line.7"></a>
<FONT color="green">008</FONT>     * &lt;p/&gt;<a name="line.8"></a>
<FONT color="green">009</FONT>     * There will be exactly one instance of each implementation. Therefore, all implementation<a name="line.9"></a>
<FONT color="green">010</FONT>     * should be thread-safe.<a name="line.10"></a>
<FONT color="green">011</FONT>     * <a name="line.11"></a>
<FONT color="green">012</FONT>     * @author (Cedric) Qin ZHANG<a name="line.12"></a>
<FONT color="green">013</FONT>     */<a name="line.13"></a>
<FONT color="green">014</FONT>    public abstract class TelemetryFunction {<a name="line.14"></a>
<FONT color="green">015</FONT>    <a name="line.15"></a>
<FONT color="green">016</FONT>      /** The name of this function. */<a name="line.16"></a>
<FONT color="green">017</FONT>      private String name;<a name="line.17"></a>
<FONT color="green">018</FONT>      <a name="line.18"></a>
<FONT color="green">019</FONT>      /**<a name="line.19"></a>
<FONT color="green">020</FONT>       * Constructs this instance.<a name="line.20"></a>
<FONT color="green">021</FONT>       * <a name="line.21"></a>
<FONT color="green">022</FONT>       * @param name The assigned name of this function.<a name="line.22"></a>
<FONT color="green">023</FONT>       */<a name="line.23"></a>
<FONT color="green">024</FONT>      protected TelemetryFunction(String name) {<a name="line.24"></a>
<FONT color="green">025</FONT>        this.name = name;    <a name="line.25"></a>
<FONT color="green">026</FONT>      }<a name="line.26"></a>
<FONT color="green">027</FONT>      <a name="line.27"></a>
<FONT color="green">028</FONT>      /**<a name="line.28"></a>
<FONT color="green">029</FONT>       * The name of this function.<a name="line.29"></a>
<FONT color="green">030</FONT>       * <a name="line.30"></a>
<FONT color="green">031</FONT>       * @return The name.<a name="line.31"></a>
<FONT color="green">032</FONT>       */<a name="line.32"></a>
<FONT color="green">033</FONT>      public String getName() {<a name="line.33"></a>
<FONT color="green">034</FONT>        return this.name;<a name="line.34"></a>
<FONT color="green">035</FONT>      }<a name="line.35"></a>
<FONT color="green">036</FONT>      <a name="line.36"></a>
<FONT color="green">037</FONT>      /**<a name="line.37"></a>
<FONT color="green">038</FONT>       * Invokes the function. Note that multiple thread might call this method at the same time.<a name="line.38"></a>
<FONT color="green">039</FONT>       * The implementation must be thread-safe.<a name="line.39"></a>
<FONT color="green">040</FONT>       * <a name="line.40"></a>
<FONT color="green">041</FONT>       * @param parameters An array of objects of type either &lt;code&gt;String&lt;/code&gt;,<a name="line.41"></a>
<FONT color="green">042</FONT>       *        &lt;code&gt;Number&lt;/code&gt;, and/or &lt;code&gt;TelemetryStreamCollection&lt;/code&gt;. <a name="line.42"></a>
<FONT color="green">043</FONT>       *        &lt;b&gt;Note: Since telemetry chart analyses might pass in parameter values as Strings,<a name="line.43"></a>
<FONT color="green">044</FONT>       *        the implementation should be prepared to handle Strings even if it is expecting<a name="line.44"></a>
<FONT color="green">045</FONT>       *        a number instance.&lt;/b&gt;<a name="line.45"></a>
<FONT color="green">046</FONT>       * <a name="line.46"></a>
<FONT color="green">047</FONT>       * @return Either an instance of &lt;code&gt;Number&lt;/code&gt; or &lt;code&gt;TelemetryStreamCollection&lt;/code&gt;.<a name="line.47"></a>
<FONT color="green">048</FONT>       *          <a name="line.48"></a>
<FONT color="green">049</FONT>       * @throws TelemetryFunctionException If anything is wrong.<a name="line.49"></a>
<FONT color="green">050</FONT>       */<a name="line.50"></a>
<FONT color="green">051</FONT>      public abstract Object compute(Object[] parameters) throws TelemetryFunctionException;<a name="line.51"></a>
<FONT color="green">052</FONT>    }<a name="line.52"></a>




























































</PRE>
</BODY>
</HTML>
